Skip to content

Add autodocs for submodules and libraries#2967

Closed
gdalle wants to merge 1 commit into
JuliaGPU:masterfrom
gdalle:gd/libdocs
Closed

Add autodocs for submodules and libraries#2967
gdalle wants to merge 1 commit into
JuliaGPU:masterfrom
gdalle:gd/libdocs

Conversation

@gdalle

@gdalle gdalle commented Nov 12, 2025

Copy link
Copy Markdown
Contributor

Every time I check out cuSPARSE I have to go to the source file to figure out what's inside CuSparseMatrixCSR. This PR is a first step that displays all the docstrings of the libraries and submodules, so that once we actually write them they will appear on the website.
Feel free to reject or modify if you don't think that's a good idea, especially if it reveals/defines "public" API that you don't want to commit to.

@kshyatt kshyatt added the documentation Improvements or additions to documentation label Nov 12, 2025
@kshyatt

kshyatt commented Nov 12, 2025

Copy link
Copy Markdown
Member

@gdalle you can put [only docs] in the commit message to avoid running the full ci (expensive!!!!) as shown in the README

@gdalle

gdalle commented Nov 12, 2025

Copy link
Copy Markdown
Contributor Author

Oops my bad! I put it in the second commit, hope it is enough

@gdalle

gdalle commented Nov 13, 2025

Copy link
Copy Markdown
Contributor Author

It seems the test suite still ran despite the following commits including "[only docs]". Does this guideline only apply to the very first commit? Should I start a new PR?

@kshyatt

kshyatt commented Nov 13, 2025 via email

Copy link
Copy Markdown
Member

@gdalle

gdalle commented Nov 13, 2025

Copy link
Copy Markdown
Contributor Author

I tried but it seems to be running anyway? Should I open a new PR?

@kshyatt

kshyatt commented Nov 13, 2025

Copy link
Copy Markdown
Member

I mean if the docs build succeeds, I'm happy to merge. We can just let it run for now tbh.

@gdalle

gdalle commented Nov 13, 2025

Copy link
Copy Markdown
Contributor Author

I'd love to learn what went wrong for next time though

@gdalle

gdalle commented Nov 13, 2025

Copy link
Copy Markdown
Contributor Author

Sorry I couldn't test the docs build locally, I don't have an NVIDIA GPU

@gdalle

gdalle commented Nov 14, 2025

Copy link
Copy Markdown
Contributor Author

Closed in favor of #2972

@gdalle gdalle closed this Nov 14, 2025
@gdalle gdalle deleted the gd/libdocs branch November 14, 2025 06:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants